home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2006 December / PCWDEC06.iso / Software / Trial / Paint Shop Pro XI / Data1.cab / cgitb.py.0160FC08_F3D9_4869_9D41_C611C16F42D5 < prev    next >
Encoding:
Text File  |  2005-06-08  |  12.1 KB  |  314 lines
  1. """More comprehensive traceback formatting for Python scripts.
  2.  
  3. To enable this module, do:
  4.  
  5.     import cgitb; cgitb.enable()
  6.  
  7. at the top of your script.  The optional arguments to enable() are:
  8.  
  9.     display     - if true, tracebacks are displayed in the web browser
  10.     logdir      - if set, tracebacks are written to files in this directory
  11.     context     - number of lines of source code to show for each stack frame
  12.     format      - 'text' or 'html' controls the output format
  13.  
  14. By default, tracebacks are displayed but not saved, the context is 5 lines
  15. and the output format is 'html' (for backwards compatibility with the
  16. original use of this module)
  17.  
  18. Alternatively, if you have caught an exception and want cgitb to display it
  19. for you, call cgitb.handler().  The optional argument to handler() is a
  20. 3-item tuple (etype, evalue, etb) just like the value of sys.exc_info().
  21. The default handler displays output as HTML.
  22. """
  23.  
  24. __author__ = 'Ka-Ping Yee'
  25. __version__ = '$Revision: 1.15 $'
  26.  
  27. import sys
  28.  
  29. def reset():
  30.     """Return a string that resets the CGI and browser to a known state."""
  31.     return '''<!--: spam
  32. Content-Type: text/html
  33.  
  34. <body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> -->
  35. <body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> --> -->
  36. </font> </font> </font> </script> </object> </blockquote> </pre>
  37. </table> </table> </table> </table> </table> </font> </font> </font>'''
  38.  
  39. __UNDEF__ = []                          # a special sentinel object
  40. def small(text):
  41.     if text:
  42.         return '<small>' + text + '</small>'
  43.     else:
  44.         return ''
  45.  
  46. def strong(text):
  47.     if text:
  48.         return '<strong>' + text + '</strong>'
  49.     else:
  50.         return ''
  51.  
  52. def grey(text):
  53.     if text:
  54.         return '<font color="#909090">' + text + '</font>'
  55.     else:
  56.         return ''
  57.  
  58. def lookup(name, frame, locals):
  59.     """Find the value for a given name in the given environment."""
  60.     if name in locals:
  61.         return 'local', locals[name]
  62.     if name in frame.f_globals:
  63.         return 'global', frame.f_globals[name]
  64.     if '__builtins__' in frame.f_globals:
  65.         builtins = frame.f_globals['__builtins__']
  66.         if type(builtins) is type({}):
  67.             if name in builtins:
  68.                 return 'builtin', builtins[name]
  69.         else:
  70.             if hasattr(builtins, name):
  71.                 return 'builtin', getattr(builtins, name)
  72.     return None, __UNDEF__
  73.  
  74. def scanvars(reader, frame, locals):
  75.     """Scan one logical line of Python and look up values of variables used."""
  76.     import tokenize, keyword
  77.     vars, lasttoken, parent, prefix, value = [], None, None, '', __UNDEF__
  78.     for ttype, token, start, end, line in tokenize.generate_tokens(reader):
  79.         if ttype == tokenize.NEWLINE: break
  80.         if ttype == tokenize.NAME and token not in keyword.kwlist:
  81.             if lasttoken == '.':
  82.                 if parent is not __UNDEF__:
  83.                     value = getattr(parent, token, __UNDEF__)
  84.                     vars.append((prefix + token, prefix, value))
  85.             else:
  86.                 where, value = lookup(token, frame, locals)
  87.                 vars.append((token, where, value))
  88.         elif token == '.':
  89.             prefix += lasttoken + '.'
  90.             parent = value
  91.         else:
  92.             parent, prefix = None, ''
  93.         lasttoken = token
  94.     return vars
  95.  
  96. def html((etype, evalue, etb), context=5):
  97.     """Return a nice HTML document describing a given traceback."""
  98.     import os, types, time, traceback, linecache, inspect, pydoc
  99.  
  100.     if type(etype) is types.ClassType:
  101.         etype = etype.__name__
  102.     pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
  103.     date = time.ctime(time.time())
  104.     head = '<body bgcolor="#f0f0f8">' + pydoc.html.heading(
  105.         '<big><big>%s</big></big>' %
  106.         strong(pydoc.html.escape(str(etype))),
  107.         '#ffffff', '#6622aa', pyver + '<br>' + date) + '''
  108. <p>A problem occurred in a Python script.  Here is the sequence of
  109. function calls leading up to the error, in the order they occurred.</p>'''
  110.  
  111.     indent = '<tt>' + small(' ' * 5) + ' </tt>'
  112.     frames = []
  113.     records = inspect.getinnerframes(etb, context)
  114.     for frame, file, lnum, func, lines, index in records:
  115.         file = file and os.path.abspath(file) or '?'
  116.         link = '<a href="file://%s">%s</a>' % (file, pydoc.html.escape(file))
  117.         args, varargs, varkw, locals = inspect.getargvalues(frame)
  118.         call = ''
  119.         if func != '?':
  120.             call = 'in ' + strong(func) + \
  121.                 inspect.formatargvalues(args, varargs, varkw, locals,
  122.                     formatvalue=lambda value: '=' + pydoc.html.repr(value))
  123.  
  124.         highlight = {}
  125.         def reader(lnum=[lnum]):
  126.             highlight[lnum[0]] = 1
  127.             try: return linecache.getline(file, lnum[0])
  128.             finally: lnum[0] += 1
  129.         vars = scanvars(reader, frame, locals)
  130.  
  131.         rows = ['<tr><td bgcolor="#d8bbff">%s%s %s</td></tr>' %
  132.                 ('<big> </big>', link, call)]
  133.         if index is not None:
  134.             i = lnum - index
  135.             for line in lines:
  136.                 num = small(' ' * (5-len(str(i))) + str(i)) + ' '
  137.                 line = '<tt>%s%s</tt>' % (num, pydoc.html.preformat(line))
  138.                 if i in highlight:
  139.                     rows.append('<tr><td bgcolor="#ffccee">%s</td></tr>' % line)
  140.                 else:
  141.                     rows.append('<tr><td>%s</td></tr>' % grey(line))
  142.                 i += 1
  143.  
  144.         done, dump = {}, []
  145.         for name, where, value in vars:
  146.             if name in done: continue
  147.             done[name] = 1
  148.             if value is not __UNDEF__:
  149.                 if where in ['global', 'builtin']:
  150.                     name = ('<em>%s</em> ' % where) + strong(name)
  151.                 elif where == 'local':
  152.                     name = strong(name)
  153.                 else:
  154.                     name = where + strong(name.split('.')[-1])
  155.                 dump.append('%s = %s' % (name, pydoc.html.repr(value)))
  156.             else:
  157.                 dump.append(name + ' <em>undefined</em>')
  158.  
  159.         rows.append('<tr><td>%s</td></tr>' % small(grey(', '.join(dump))))
  160.         frames.append('''
  161. <table width="100%%" cellspacing=0 cellpadding=0 border=0>
  162. %s</table>''' % '\n'.join(rows))
  163.  
  164.     exception = ['<p>%s: %s' % (strong(pydoc.html.escape(str(etype))),
  165.                                 pydoc.html.escape(str(evalue)))]
  166.     if type(evalue) is types.InstanceType:
  167.         for name in dir(evalue):
  168.             if name[:1] == '_': continue
  169.             value = pydoc.html.repr(getattr(evalue, name))
  170.             exception.append('\n<br>%s%s =\n%s' % (indent, name, value))
  171.  
  172.     import traceback
  173.     return head + ''.join(frames) + ''.join(exception) + '''
  174.  
  175.  
  176. <!-- The above is a description of an error in a Python program, formatted
  177.      for a Web browser because the 'cgitb' module was enabled.  In case you
  178.      are not reading this in a Web browser, here is the original traceback:
  179.  
  180. %s
  181. -->
  182. ''' % ''.join(traceback.format_exception(etype, evalue, etb))
  183.  
  184. def text((etype, evalue, etb), context=5):
  185.     """Return a plain text document describing a given traceback."""
  186.     import os, types, time, traceback, linecache, inspect, pydoc
  187.  
  188.     if type(etype) is types.ClassType:
  189.         etype = etype.__name__
  190.     pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
  191.     date = time.ctime(time.time())
  192.     head = "%s\n%s\n%s\n" % (str(etype), pyver, date) + '''
  193. A problem occurred in a Python script.  Here is the sequence of
  194. function calls leading up to the error, in the order they occurred.
  195. '''
  196.  
  197.     frames = []
  198.     records = inspect.getinnerframes(etb, context)
  199.     for frame, file, lnum, func, lines, index in records:
  200.         file = file and os.path.abspath(file) or '?'
  201.         args, varargs, varkw, locals = inspect.getargvalues(frame)
  202.         call = ''
  203.         if func != '?':
  204.             call = 'in ' + func + \
  205.                 inspect.formatargvalues(args, varargs, varkw, locals,
  206.                     formatvalue=lambda value: '=' + pydoc.text.repr(value))
  207.  
  208.         highlight = {}
  209.         def reader(lnum=[lnum]):
  210.             highlight[lnum[0]] = 1
  211.             try: return linecache.getline(file, lnum[0])
  212.             finally: lnum[0] += 1
  213.         vars = scanvars(reader, frame, locals)
  214.  
  215.         rows = [' %s %s' % (file, call)]
  216.         if index is not None:
  217.             i = lnum - index
  218.             for line in lines:
  219.                 num = '%5d ' % i
  220.                 rows.append(num+line.rstrip())
  221.                 i += 1
  222.  
  223.         done, dump = {}, []
  224.         for name, where, value in vars:
  225.             if name in done: continue
  226.             done[name] = 1
  227.             if value is not __UNDEF__:
  228.                 if where == 'global': name = 'global ' + name
  229.                 elif where != 'local': name = where + name.split('.')[-1]
  230.                 dump.append('%s = %s' % (name, pydoc.text.repr(value)))
  231.             else:
  232.                 dump.append(name + ' undefined')
  233.  
  234.         rows.append('\n'.join(dump))
  235.         frames.append('\n%s\n' % '\n'.join(rows))
  236.  
  237.     exception = ['%s: %s' % (str(etype), str(evalue))]
  238.     if type(evalue) is types.InstanceType:
  239.         for name in dir(evalue):
  240.             value = pydoc.text.repr(getattr(evalue, name))
  241.             exception.append('\n%s%s = %s' % (" "*4, name, value))
  242.  
  243.     import traceback
  244.     return head + ''.join(frames) + ''.join(exception) + '''
  245.  
  246. The above is a description of an error in a Python program.  Here is
  247. the original traceback:
  248.  
  249. %s
  250. ''' % ''.join(traceback.format_exception(etype, evalue, etb))
  251.  
  252. class Hook:
  253.     """A hook to replace sys.excepthook that shows tracebacks in HTML."""
  254.  
  255.     def __init__(self, display=1, logdir=None, context=5, file=None,
  256.                  format="html"):
  257.         self.display = display          # send tracebacks to browser if true
  258.         self.logdir = logdir            # log tracebacks to files if not None
  259.         self.context = context          # number of source code lines per frame
  260.         self.file = file or sys.stdout  # place to send the output
  261.         self.format = format
  262.  
  263.     def __call__(self, etype, evalue, etb):
  264.         self.handle((etype, evalue, etb))
  265.  
  266.     def handle(self, info=None):
  267.         info = info or sys.exc_info()
  268.         if self.format == "html":
  269.             self.file.write(reset())
  270.  
  271.         formatter = (self.format=="html") and html or text
  272.         plain = False
  273.         try:
  274.             doc = formatter(info, self.context)
  275.         except:                         # just in case something goes wrong
  276.             import traceback
  277.             doc = ''.join(traceback.format_exception(*info))
  278.             plain = True
  279.  
  280.         if self.display:
  281.             if plain:
  282.                 doc = doc.replace('&', '&').replace('<', '<')
  283.                 self.file.write('<pre>' + doc + '</pre>\n')
  284.             else:
  285.                 self.file.write(doc + '\n')
  286.         else:
  287.             self.file.write('<p>A problem occurred in a Python script.\n')
  288.  
  289.         if self.logdir is not None:
  290.             import os, tempfile
  291.             suffix = ['.txt', '.html'][self.format=="html"]
  292.             (fd, path) = tempfile.mkstemp(suffix=suffix, dir=self.logdir)
  293.             try:
  294.                 file = os.fdopen(fd, 'w')
  295.                 file.write(doc)
  296.                 file.close()
  297.                 msg = '<p> %s contains the description of this error.' % path
  298.             except:
  299.                 msg = '<p> Tried to save traceback to %s, but failed.' % path
  300.             self.file.write(msg + '\n')
  301.         try:
  302.             self.file.flush()
  303.         except: pass
  304.  
  305. handler = Hook().handle
  306. def enable(display=1, logdir=None, context=5, format="html"):
  307.     """Install an exception handler that formats tracebacks as HTML.
  308.  
  309.     The optional argument 'display' can be set to 0 to suppress sending the
  310.     traceback to the browser, and 'logdir' can be set to a directory to cause
  311.     tracebacks to be written to files there."""
  312.     sys.excepthook = Hook(display=display, logdir=logdir,
  313.                           context=context, format=format)
  314.